マルペイDocs

概要

本章では、パラメータ型、キー型共通のURL作成に必要な実行パラメータセット、および、画面遷移、結果パラメータセットを解説します。

パラメータ型カード編集URLの構成

パラメータ型のリンクタイプ Plusカード編集URLを以下に示します。

①	プロトコル	https（httpは利用不可)
②	ドメイン	環境によって異なります。 本番環境：link.mul-pay.jp テスト環境：stg.link.mul-pay.jp
③	バージョン	"v1"固定です。
④	機能名	"plus"固定です。
⑤	ショップID	加盟店様のショップIDです。
⑥	機能種別	カード編集機能を示す"member"を指定します。
⑦	ハッシュ付き実行パラメータセット	取引を定義するためのパラメータのbase64（※）文字列です。 詳細については後述します。 （※ URLSafe／文字コード：UTF-8）

ハッシュ付き実行パラメータセットの生成方法

リンクタイプ Plusのカード編集画面を呼び出すためには、編集の内容を示す各種パラメータ(会員IDや編集を特定するカード編集番号等)一式が必要です。これらパラメータ一式を「実行パラメータセット」と呼びます。 実行パラメータセットはjson形式で表現しますが、リンクタイプ Plusカード編集URLに付与する際は、base64エンコード（URLSafe）を行い、パラメータ改ざんチェック用にハッシュを付与したハッシュ付き実行パラメータセット文字列にします。

ハッシュ付き実行パラメータセットの導出方法を以下に示します。

パラメータ型カード編集URL生成コードサンプル

パラメータ型カード編集URL生成時のコードサンプルは管理画面より確認できます。

1.　トップメニューの"コードサンプル"をクリック

2.　決済プルダウンより"リンクタイプ PLUS"を選択し、言語を選択

3.　"表示"をクリック

4.　"カード編集URL生成(V1)"をクリック

ハッシュについて

お客様がリンクタイプ Plusカード編集URLにアクセスすると、弊社システムではURLからハッシュ付き実行パラメータを取得しハッシュ値の検証を行います。
ハッシュ値が正しい場合はカード編集画面を表示しますが、ハッシュ値が異なる場合は不正なアクセスと扱い、エラー画面を表示します。

本チェック処理により、悪意を持った実行パラメータセットの改ざんを検知/ブロックします。

キー型カード編集URLの構成

キー型のリンクタイプ Plusカード編集URLを以下に示します。

①	プロトコル	https（httpは利用不可)
②	ドメイン	環境によって異なります。 本番環境：link.mul-pay.jp テスト環境：stg.link.mul-pay.jp
③	バージョン	"v2"固定です。
④	機能名	"plus"固定です。
⑤	ショップID	加盟店様のショップIDです。
⑥	機能種別	カード編集機能を示す"member"を指定します。
⑦	キー	取引を特定するためのキーです。

実行パラメータセットのデフォルト値について

実行パラメータセットの画面表示設定は、加盟店様が管理画面上でデフォルト値を設定することが可能です。
リンクタイプ Plusカード編集URLで省略した実行パラメータに対しては加盟店様が設定したデフォルト値が使用されます（リンクタイプ Plusカード編集URLとデフォルト値の両方が指定されていた場合はリンクタイプ Plusカード編集URLで指定した値が使用されます）。

また、実行パラメータのデフォルト値は、管理画面上で複数登録できます。デフォルト値を登録する際は「設定ID」を指定し、その「設定ID」に対して実行パラメータのデフォルト値を登録します（デフォルト値の登録方法については、 管理画面マニュアルをご覧ください）。
リンクタイプ Plusカード編集URLにおいて、「設定ID」を指定することにより、複数登録されているデフォルト実行パラメータセットの中から使用するパラメータ値を特定します。

画面デザイン等の取引毎に共通(不変)な実行パラメータは管理画面でデフォルト値を設定し、リンクタイプ Plusカード編集URLではカード編集番号/会員ID等の取引毎に異なる実行パラメータのみを指定してください。

実行パラメータセット項目説明

実行パラメータは、加盟店様が指定する入力パラメータ群であり、リンクタイプ Plusカード編集画面表示およびカード編集実行に必要な項目です。

これらの項目はリンクタイプ Plusカード編集URLの一部として指定するか、管理画面のリンクタイプ Plus設定画面で指定します。

実行パラメータ項目

json key		詳細	指定可能箇所		システムデフォルト設定
			リンクタイプPlus決済URL	加盟店デフォルト設定
configid		必須 半角英数16桁 設定ID 管理画面で登録したデフォルト実行パラメータセットの設定IDを指定します。	〇	-	(null)
member		必須 会員編集情報 会員編集で必要なパラメータセットです。	〇	-
	MemberID	必須 半角英数記号60桁 会員ID 新規会員登録、または更新を行う会員IDを指定します。	〇	-	(null)
	MemberName	全半角255バイト 会員名 新規会員登録時の会員名を指定します。 更新時に設定した場合、本項目の値は使用されません。	〇	-	(null)
	Cardeditno	必須 半角英数記号27桁 カード編集番号 取引を特定する識別子です。 注意 カード編集機会毎に一意になる番号を指定してください。	〇	-	(null)
	SrcPayMethod	カード番号取得元決済手段 カード番号取得元の決済手段を設定します。 決済識別子 決済手段 credit クレジットカード dcc 多通貨クレジットカード決済（DCC）	〇	〇	credit
	SrcOrderID	半角英数記号27桁 カード番号取得元オーダーID カード番号取得元のオーダーIDを設定します。 本パラメータを使用すると決済時に使用したカード番号が初期表示されます。 お客様の決済が正常終了している場合のみ使用可能です。 注意 本項目を設定し、本人認証を実施する設定を行った場合、お客様のカード編集時にエラーが発生します。 本人認証を行う場合は設定しないでください。	〇	-	(null)
	RetUrl	半角英数記号256桁 戻り先URL リンクタイプ Plus編集画面上に表示される「サイトに戻る」ボタン押下時の遷移先URLです。 「サイトに戻る」ボタンの遷移先を完了時とキャンセル時で個別に設定する場合は、 「完了時戻り先URL」と「キャンセル時戻り先URL」を設定してください。 「サイトに戻る」ボタンの動作パターンについては「カード編集画面からの加盟店様サイトへの遷移」をご覧ください。	〇	〇	(null)
	CompleteUrl	半角英数字記号256桁 完了時戻り先URL リンクタイプ Plus編集結果画面上に表示される「サイトに戻る」ボタン押下時の遷移先URLです。 本項目を設定した場合、「戻り先URL」の設定は無効になります。 「サイトに戻る」ボタンの動作パターンについては「カード編集画面からの加盟店様サイトへの遷移」をご覧ください。	〇	〇	(null)
	CancelUrl	半角英数字記号256桁 キャンセル時戻り先URL リンクタイプ Plus編集結果画面以外に表示される「サイトに戻る」ボタン押下時の遷移先URLです。 本項目を設定した場合、「戻り先URL」の設定は無効になります。 「サイトに戻る」ボタンの動作パターンについては「カード編集画面からの加盟店様サイトへの遷移」をご覧ください。	〇	〇	(null)
	NotifyMailaddress	半角英数記号256桁 編集完了通知先メールアドレス 編集完了時に加盟店様に送付する編集完了通知メールの送付先メールアドレスです。 省略時は、編集完了通知メールが送信されません。	〇	〇	(null)
	RetryMax	半角数字2桁 リトライ最大回数 カード登録失敗時に再入力可能な回数です。 0～99を指定可能です。	〇	〇	5
	ExpireDays	半角数字2桁 取引有効日数 リンクタイプ Plus取引の有効な日数です。 指定した日数を経過した時点で、リンクタイプ Plus取引は有効期限切れ状態になります。 0を指定した場合は当日中、１を指定した場合は翌日中、省略時は無期限と扱われます。 編集可能期限も設定した場合、先に期限が到来する設定が有効になります。 詳細は注意事項をご覧ください。	〇	〇	(null)
	EditExpireDate	半角数字12桁 編集可能期限 編集画面を表示可能な期限を設定できます。 （yyyymmddhhMM形式） 例：「202006162359」を設定した場合、2020年6月17日0時以降は編集画面表示時にエラー 取引有効日数も設定した場合、先に期限が到来する設定が有効になります。 詳細は注意事項をご覧ください。	〇	-	(null)
	SecCodeRequiredFlag	半角数字1桁 セキュリティコード必須フラグ ONにすると、セキュリティコード入力欄を表示します。 0:OFF（表示しない） 1:ON（表示する）  ※セキュリティコードの入力が必須となります	〇	〇	0
	CardEditHiddenFlag	半角数字1桁 編集ボタン非表示フラグ ONにすると、編集ボタンを非表示にできます。 0:OFF（表示する） 1:ON（表示しない）  ※カード情報の編集が不可能になります	〇	〇	0
	CardDeleteHiddenFlag	半角数字1桁 削除ボタン非表示フラグ ONにすると、削除ボタンを非表示にできます。 0:OFF（表示する） 1:ON（表示しない）  ※カード情報の削除が不可能になります	〇	〇	0
	CardAddHiddenFlag	半角数字1桁 追加ボタン非表示フラグ ONにすると、追加ボタンを非表示にできます。 0:OFF（表示する） 1:ON（表示しない）  ※カード情報の追加が不可能になります	〇	〇	0
	CardMaxCnt	半角数字1桁 最大カード登録枚数 1会員で登録可能な最大カード枚数を設定したい場合に指定します。 指定可能な値は1~5までになります。 ※最大カード登録枚数の設定が行われている場合、追加ボタン非表示フラグの設定は使用されません。 ※カード編集機能と決済後カード登録機能を併用しており、両機能で最大カード登録枚数を制御したい場合、カード編集機能と決済後カード登録機能の両方で設定が必要となります。	〇	〇	(null)
	MemberIDHiddenFlag	半角数字1桁 会員ID非表示フラグ ONにすると、会員IDを非表示にできます。 0:OFF（表示する） 1:ON（表示しない）	〇	〇	0
	MemberNameHiddenFlag	半角数字1桁 会員名非表示フラグ ONにすると、会員名を非表示にできます。 0:OFF（表示する） 1:ON（表示しない）	〇	〇	0
	ResultSkipFlag	半角数字1桁 結果画面スキップフラグ ONにすると、結果画面をスキップし、完了時の戻り先に遷移します。 完了時の戻り先が設定されていない場合、結果画面はスキップされません。 完了時の戻り先は結果画面の「サイトに戻るボタン」と同じ遷移先となります。 詳細は「カード編集画面からの加盟店様サイトへの遷移」をご覧ください。 0:OFF（スキップしない） 1:ON（スキップする）	〇	〇	0
	ConfirmSkipFlag	半角数字1桁 確認画面スキップフラグ ONにすると、確認画面をスキップし、次画面へ遷移します。 0:OFF（スキップしない） 1:ON（スキップする）	〇	〇	0
	TdFlag	半角数字1桁 本人認証サービス利用フラグ 本人認証サービスを使用してカード編集を行うかを指定します。 以下のいずれかを設定します。 設定値 説明 0 利用しない  3Dセキュア認証せず、カード編集をします。 1 3DS1.0を利用する  3Dセキュア1.0認証サポート終了のため、1以外を指定してください。指定した場合、ショップの「3DS1.0認証（サポート終了）の取り扱い」の設定に従い、カード編集をします。 2 契約に従う  3Dセキュア（本人認証）のご契約に従います。 ・ご契約されている場合には3Dセキュア認証実施のうえ、カード編集をします。 ・ご契約されていない場合には3Dセキュア認証せず、カード編集をします。 3 3DS2.0を利用する  3Dセキュア2.0認証実施のうえ、カード編集をします（ご契約されていない場合には、エラーとなります）。 注意 本人認証サービスを必須としている場合、本項目も必ず「3DS2.0を利用する」の設定としてください。「利用しない」の設定がされた場合、お客様のカード編集時にエラーが発生します。 ※3DS2.0を利用すると、 指定したショップに対してクレジットカード取引を自動生成します。 （オーダーIDは当サービス独自の命名ルールで発番。 処理区分は"CHECK(有効性チェック)"）	〇	〇	0
	TdTenantName	半角英数記号25桁 3Dセキュア表示店舗名 3Dセキュア画面に表示する店舗名を指定します。 EUC-JPでBASE64エンコーディングした値を指定します（日本語も使用可能ですが、文字化けが起こりやすいので使用する場合は十分な検証を実施してください）。 省略時は店舗名が「未指定」となります。	〇	〇	(null)
tds2		3DS2.0設定 3DS2.0に関するパラメータセットです。
	Tds2Type	半角数字1桁 3DS2.0未対応時取り扱い 3DS2.0未対応カード時の後続処理について指定します。 1:3DS1.0での認証を実施 2:エラーとして処理終了 3:通常オーソリを実施 3DS1.0認証サポート終了のため、1以外を指定してください。 1を指定した場合、ショップの「3DS1.0認証（サポート終了）の取り扱い」の設定に従います。	〇	-	1
displaysetting		画面表示設定 画面表示に関するパラメータセットです。	-	-	-
	LogoUrl	半角英数記号256桁 ロゴ画像URL 決済画面に表示するロゴ画像のURLです。「https」で始まるURLを指定してください。 ロゴ画像の横幅が222 pxを超える場合、横幅が最大222 pxとなるように縦横比を保持して自動的にサイズ調整を行います。 省略時は、ロゴが表示されません。	〇	〇	(null)
	ShopName	全半角128桁 ショップ名 決済画面に表示するショップ名です。 省略時は、ショップ名を表示しません。	〇	〇	(null)
	ColorPattern	カラーパターン 決済画面の色合いを指定できます。以下の種類から選択可能です。 省略時は、blue_01を使用します。各カラーの特徴は以下の通りです。 設定値 特徴 blue_01 青を基調とした明るい色合いです。 bluegray_01 灰色を基調とした落ち着いた色合いです。 skyblue_01 青空をイメージさせる爽やかな色合いです。 pink_01 春の桜をイメージさせる色合いです。 yellow_01 黄色を基調とした淡い色合いです。 black_01 黒を基調としたビビッとした色合いです。 nature_01 自然を感じさせる牧歌的な色合いです。 greengray_01 灰色に緑を溶け込ませた穏やかな色合いです。	〇	〇	blue_01
	Lang	半角英数2桁 言語コード 決済画面に表示する言語(ISO639コード)です。以下の言語から選択可能です。 省略時は、jaを使用します。 設定値 言語 ja 日本語 en 英語 zh 中国語（簡体字）	〇	〇	ja
	ShopDomain	ショップドメイン 決済画面をiframeなどを使用して表示する際に表示するページのドメインを配列で指定します。 iframeで表示しない場合は指定しないでください。 最大5件設定可能で、1件あたり、ドメイン部分は253バイトまで許容しています。 半角英数63バイトまでの文字を、.(ドット)でつないで設定できます。 加盟店様での開発のために、http / https などのプロトコルと、IPアドレスV4、ポート番号を設定可能です。 例1）ドメイン名のみの指定 example.com 例2）ドメイン名とプロトコルの指定 http://example.com 例3）ドメイン名とプロトコル、ポート番号の指定 http://example.com:8080 例4）IPアドレスの指定 http://127.0.0.1:8080 IPアドレスの指定はIPV4に対応しています。 必ずプロトコルとポート番号を指定してください。 ShopDomain設定例） 単数設定する場合：["example.com"] 複数設定する場合：["example.com","http://127.0.0.1:8080"]	〇	〇	(null)
	TemplateID	テンプレートID 画面レイアウトを以下から選択可能です。 テンプレート識別子 説明 designA コンボボックスを使用して、決済手段を選択します。 1~5 加盟店様サイトに近づけたカード編集画面を提供することができます。 オリジナルデザインの公開データが作成されている場合、1~5を指定可能です。 オリジナルデザインについてはオリジナルデザイン利用マニュアルをご確認ください。 オリジナルデザイン機能は、現在テスト環境でのみ利用可能です。 ※本番環境では、2024年5月28日から利用可能となります。	〇	〇	(null)

実行パラメータ仕様（3DS2.0）

3DS2.0専用のパラメータは以下の通りです。決済URL取得API実行時のみ、指定可能です。

json key		詳細	指定可能箇所		システムデフォルト設定
			リンクタイプPlus決済URL	加盟店デフォルト設定
tds2		3DS2.0設定 3DS2.0に関するパラメータセットです。	-	-	-
	Tds2ChAccChange	半角数字8桁 固定 カード会員最終更新日 カード会員情報の最終更新日を設定します。 YYYYMMDD形式で設定してください。	〇	-	(null)
	Tds2ChAccDate	半角数字8桁 固定 カード会員作成日 カード会員の作成日を設定します。 YYYYMMDD形式で設定してください。	〇	-	(null)
	Tds2ChAccPwChange	半角数字8桁 固定 カード会員パスワード変更日 カード会員のパスワード変更日を設定します。 YYYYMMDD形式で設定してください。	〇	-	(null)
	Tds2NbPurchaseAccount	半角数字4桁 過去6ヶ月間の購入回数 過去6ヶ月間に、このカード会員が購入した回数を設定します。	〇	-	(null)
	Tds2PaymentAccAge	半角数字8桁 固定 カード登録日 カード会員にカード情報が登録された日付を設定します。 YYYYMMDD形式で設定してください。	〇	-	(null)
	Tds2ProvisionAttemptsDay	半角数字3桁 過去24時間のカード追加の試行回数 過去24時間に行われたカード情報追加の試行回数を設定します。	〇	-	(null)
	Tds2ShipAddressUsage	半角数字8桁 固定 配送先住所の初回使用日 取引で使用される配送先住所が加盟店様で最初に使用された日付を設定します。 YYYYMMDD形式で設定してください。	〇	-	(null)
	Tds2ShipNameInd	カード会員名と配送先名の一致/不一致 カード会員の会員名と取引に使用される配送先名の一致/不一致を設定します。 01:カード会員名と配送先名が一致 02:カード会員名と配送先名が不一致	〇	-	(null)
	Tds2SuspiciousAccActivity	カード会員の不審行為情報 カード会員で、不審な行動（過去の不正行為を含む）を加盟店様が発見したかどうかを設定します。 01:不審な行動は見られなかった 02:不審な行動が見られた	〇	-	(null)
	Tds2TxnActivityDay	半角数字3桁 過去24時間の取引回数 過去24時間に行われた、カード会員と加盟店様との取引の回数を設定します。	〇	-	(null)
	Tds2TxnActivityYear	半角数字3桁 前年の取引回数 前年に行われた、カード会員と加盟店様との取引の回数を設定します。	〇	-	(null)
	Tds2DeliveryEmailAddress	半角英数記号254桁 納品先電子メールアドレス 電子デリバリーの場合、商品を納品したときの納品先電子メールアドレスを設定します。	〇	-	(null)
	Tds2DeliveryTimeframe	商品納品時間枠 商品納品時間枠を設定します。 01:電子デリバリー 02:当日出荷 03:翌日出荷 04:2日目以降の出荷	〇	-	(null)
	Tds2GiftCardAmount	半角数字15桁 プリペイドカードまたはギフトカードの総購入金額 プリペイドカードまたはギフトカードを購入の場合、総購入金額の小数点以上の値を設定します。	〇	-	(null)
	Tds2GiftCardCount	半角数字2桁 購入されたプリペイドカードまたはギフトカードの総数 プリペイドカードまたはギフトカードを購入の場合、購入された総数を設定します。	〇	-	(null)
	Tds2GiftCardCurr	半角数字3桁 固定 購入されたプリペイドカードまたはギフトカードの通貨コード プリペイドカードまたはギフトカードを購入の場合、カードの通貨を表す、ISO 4217で定義されている通貨コードを設定します。 ※以下のコードは対象外です。   955, 956, 957, 958, 959, 960, 961, 962, 963, 964, 999	〇	-	(null)
	Tds2PreOrderDate	半角数字8桁 固定 商品の発売予定日 先行予約購入の場合は、商品の発売予定日を設定します。 YYYYMMDD形式で設定してください。	〇	-	(null)
	Tds2PreOrderPurchaseInd	半角数字2桁 商品の販売時期情報 先行予約購入か、発売済み商品の購入かを設定します。 01:発売済み商品 02:先行予約商品	〇	-	(null)
	Tds2ReorderItemsInd	半角数字2桁 商品の注文情報 カード会員が以前購入した商品を再び注文しているかどうかを設定します。 01:初回注文 02:再注文	〇	-	(null)

表の説明

• ・「指定可能箇所／リンクタイプ Plus決済URL」に○が付いている場合、リンクタイプ Plus決済URLで指定が可能です。
• ・「指定可能箇所／加盟店デフォルト設定」に○が付いている場合、管理画面で指定が可能です。
• ・「システムデフォルト値」は「リンクタイプ Plus決済URL」「加盟店デフォルト設定」で指定が無い場合に使われる値です。
• ※使用されるパラメータの優先順位は以下の通りです。
  ①リンクタイプ Plus決済URL →②加盟店デフォルト設定→③システムデフォルト値

設定した項目は以下の通り、画面に表示されます。

図 設定値と画面表示対応

カード編集画面からの加盟店様サイトへの遷移

実行パラメータセットの戻り先URL、完了時戻り先URL、キャンセル時戻り先URLの内いずれかの戻り先URLを指定すると、リンクタイプ Plusカード編集画面上に「サイトに戻る」ボタンが表示され、該当ボタンを押下すると遷移先URLへ画面遷移します。

「サイトに戻る」ボタン押下時の動作は以下の通りです。

遷移先URL	下表参照
メソッド	POST
パラメータ	"result"にハッシュ付き結果パラメータセットを設定 ハッシュ仕様はハッシュ付き実行パラメータセットと同じです。 結果パラメータセットの仕様は次頁をご覧ください。

実行パラメータの設定			サイトに戻るボタン
戻り先URL （RetUrl）	完了時戻り先URL （CompleteUrl）	キャンセル時戻り先URL （CancelUrl）	編集結果画面	編集結果画面以外
あり	なし	なし	「戻り先URL」に遷移する	「戻り先URL」に遷移する
なし	なし	なし	非表示	非表示
あり	あり	あり	「完了時戻り先URL」に遷移する	「キャンセル時戻り先URL」に遷移する
あり	あり	なし	「完了時戻り先URL」に遷移する	非表示
あり	なし	あり	非表示	「キャンセル時戻り先URL」に遷移する
なし	あり	あり	「完了時戻り先URL」に遷移する	「キャンセル時戻り先URL」に遷移する
なし	あり	なし	「完了時戻り先URL」に遷移する	非表示
なし	なし	あり	非表示	「キャンセル時戻り先URL」に遷移する

結果パラメータセット項目説明

本章ではカード編集の結果パラメータセットについて説明します。

結果パラメータ項目